package com.lzp.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * 生成Swagger文档
 *
 * @author lzp
 * @date 2020/7/26
 */
@Configuration
@EnableSwagger2
public class Swagger2 {

    // 官方UI访问地址：http://localhost:8080/swagger-ui.html
    // 第三方UI访问地址：http://localhost:8080/doc.html

    /**
     * api接口扫描路径
     */
    private static final String SWAGGER_SCAN_BASE_PACKAGE = "com.lzp.controller";

    /**
     * 版本号
     */
    private static final String VERSION = "1.0.0";

    /**
     * Swagger核心配置
     *
     * @return
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2) // 指定API类型
                .apiInfo(apiInfo()) // 定义文档信息
                .select() // 返回一个ApiSelectorBuilder，控制哪些接口暴露给Swagger
                .apis(RequestHandlerSelectors.basePackage(SWAGGER_SCAN_BASE_PACKAGE)) // 指定要生成文档的接口路径
                .paths(PathSelectors.any()) // 路径下所有api都生成
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("电子商城EMall API接口文档") // 标题
                .contact(new Contact("lzp",
                        "https://www.awecoder.com",
                        "awecoder@163.com")) // 联系人
                .description("项目API详细文档") // 详细说明
                .version(VERSION) // 版本号
                .termsOfServiceUrl("emall.awecoder.com") // 网站地址
                .build();
    }
}
